Simple signer CLI #1203

kantai · 2020-01-02T21:36:13Z

This is a simple transaction generation and signer CLI.

For now, this only supports standard single-single transactions. We can expand the feature set later if we want it to be expanded (good multi-sig support would probably require some refactoring in the TransactionAuth, Transaction, and TransactionSigner structs, as well as breaking generation & signing into two different CLI methods).

$ ./target/debug/blockstack-cli -h
blockstack-cli (options) [method] [args...]

This CLI allows you to generate simple signed transactions for blockstack-core
to process.

This CLI has two methods:

  publish          used to generate and sign a contract publish transaction
  contract-call    used to generate and sign a contract-call transaction
  generate-sk      used to generate a secret key for transaction signing

For usage information on those methods, call `blockstack-cli [method] -h`

`blockstack-cli` accepts flag options as well:

   --testnet       instruct the transaction generator to use a testnet version byte instead of MAINNET (default)


$ ./target/debug/blockstack-cli generate-sk -h
USAGE:
 blockstack-cli (options) generate-sk

This method generates a secret key, outputting the hex encoding of the
secret key, the corresponding public key, and the corresponding P2PKH Stacks address.

$ ./target/debug/blockstack-cli publish -h
USAGE:
 blockstack-cli (options) publish [publisher-secret-key-hex] [fee-rate] [nonce] [contract-name] [file-name.clar]

The publish command generates and signs a contract publish transaction. If successful,
this command outputs the hex string encoding of the transaction to stdout, and exits with
code 0

$ ./target/debug/blockstack-cli contract-call -h
USAGE:
 blockstack-cli (options) contract-call [origin-secret-key-hex] [fee-rate] [nonce] [contract-publisher-address] [contract-name] [function-name] [args...]

The contract-call command generates and signs a contract-call transaction. If successful,
this command outputs the hex string encoding of the transaction to stdout, and exits with
code 0

Arguments are supplied in one of two ways: through script evaluation or via hex encoding
of the value serialization format. The method for supplying arguments is chosen by
prefacing each argument with a flag:

  -e  indicates the argument should be _evaluated_
  -x  indicates the argument is supplied as a hexstring of the value serialization

e.g.,

   blockstack-cli contract-call $secret_key SPJT598WY1RJN792HRKRHRQYFB7RJ5ZCG6J6GEZ4 10 0 foo-contract \
      transfer-fookens -e \'SPJT598WY1RJN792HRKRHRQYFB7RJ5ZCG6J6GEZ4 \
                       -e "(+ 1 2)" \
                       -x 0000000000000000000000000000000001 \
                       -x 050011deadbeef11ababffff11deadbeef11ababffff

Note that arguments supplied via the -x flag currently would want the JSON serialization scheme, but would change to the more compact serialization once #1199 merges.

…unts' into feature/signer-cli

codecov · 2020-01-02T21:57:07Z

Codecov Report

❗ No coverage uploaded for pull request base (feature/testnet-runloop@8a06405). Click here to learn what that means.
The diff coverage is 24.26%.

@@                    Coverage Diff                     @@
##             feature/testnet-runloop    #1203   +/-   ##
==========================================================
  Coverage                           ?   82.61%           
==========================================================
  Files                              ?      149           
  Lines                              ?    40231           
  Branches                           ?        0           
==========================================================
  Hits                               ?    33237           
  Misses                             ?     6994           
  Partials                           ?        0

Impacted Files	Coverage Δ
src/testnet/mod.rs	`0% <ø> (ø)`
src/chainstate/stacks/db/blocks.rs	`88.98% <ø> (ø)`
src/testnet/tenure.rs	`0% <0%> (ø)`
src/testnet/keychain.rs	`0% <0%> (ø)`
src/testnet/run_loop.rs	`0% <0%> (ø)`
src/testnet/node.rs	`0% <0%> (ø)`
src/testnet/burnchain.rs	`0% <0%> (ø)`
src/testnet/mem_pool.rs	`0% <0%> (ø)`
src/blockstack_cli.rs	`80% <100%> (ø)`
src/util/secp256k1.rs	`84.58% <100%> (ø)`

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 8a06405...6bdf72a. Read the comment docs.

…accounts Feature/blocks transactions accounts

jcnelson · 2020-01-05T19:06:24Z

src/blockstack_cli.rs

+This CLI allows you to generate simple signed transactions for blockstack-core
+to process.
+
+This CLI has two methods:


"three methods"

jcnelson · 2020-01-05T19:07:45Z

src/blockstack_cli.rs

+
+e.g.,
+
+   blockstack-cli contract-call $secret_key SPJT598WY1RJN792HRKRHRQYFB7RJ5ZCG6J6GEZ4 10 0 foo-contract \\


This example doesn't match the usage.

jcnelson · 2020-01-05T19:08:28Z

src/blockstack_cli.rs

+      transfer-fookens -e \\'SPJT598WY1RJN792HRKRHRQYFB7RJ5ZCG6J6GEZ4 \\
+                       -e \"(+ 1 2)\" \\
+                       -x 0000000000000000000000000000000001 \\
+                       -x 050011deadbeef11ababffff11deadbeef11ababffff


To clarify, does -x indicate that a serialized Clarity value is being passed?

jcnelson

LGTM @kantai! Just a few minor changes in the documentation, and it should be good to go. You might need to re-base off of develop first though.

lgalabru

Used for testing #1202, looks good to me! Thanks @kantai

kantai added 7 commits December 19, 2019 10:57

initial work

8b29bc7

Merge remote-tracking branch 'origin/feature/blocks-transactions-acco…

c8408b0

…unts' into feature/signer-cli

wrap up basic cli construction

adb6bfa

add sk generator command

fb55cac

Merge branch 'feature/testnet-runloop' into feature/signer-cli

a9c14b6

add rudimentary tests

c3aeed8

add generate-sk to usage output

2e97f96

jcnelson added 5 commits January 3, 2020 10:02

remove dead code

16b5e2c

remove dead code

d1d4fac

remove dead code

1c2fcd8

handle Result<> from serialize_write()

1647b56

Merge pull request #1151 from blockstack/feature/blocks-transactions-…

2aaa2e8

…accounts Feature/blocks transactions accounts

jcnelson reviewed Jan 5, 2020

View reviewed changes

jcnelson approved these changes Jan 5, 2020

View reviewed changes

kantai added 4 commits January 6, 2020 09:28

Merge branch 'develop' into feature/signer-cli

047d625

fix merge error

8a06405

Merge branch 'feature/testnet-runloop' into feature/signer-cli

8dce67c

fix serialization of compress_public in secp256k1 private key

6123cda

lgalabru mentioned this pull request Jan 7, 2020

Local testnet implementation #1202

Merged

kantai added 3 commits January 7, 2020 09:42

correct documentation

fc4f1ef

more error coverage

9f5f9d8

more coverage

6bdf72a

kantai requested a review from lgalabru January 7, 2020 21:37

kantai self-assigned this Jan 7, 2020

jcnelson approved these changes Jan 13, 2020

View reviewed changes

lgalabru approved these changes Jan 14, 2020

View reviewed changes

kantai merged commit 573b47a into feature/testnet-runloop Jan 14, 2020

kantai deleted the feature/signer-cli branch January 14, 2020 22:35

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Simple signer CLI #1203

Simple signer CLI #1203

kantai commented Jan 2, 2020 •

edited

Loading

codecov bot commented Jan 2, 2020 •

edited

Loading

jcnelson Jan 5, 2020

jcnelson Jan 5, 2020 •

edited

Loading

jcnelson Jan 5, 2020

kantai Jan 7, 2020

jcnelson left a comment

lgalabru left a comment


		e.g.,

		blockstack-cli contract-call $secret_key SPJT598WY1RJN792HRKRHRQYFB7RJ5ZCG6J6GEZ4 10 0 foo-contract \\

Simple signer CLI #1203

Simple signer CLI #1203

Conversation

kantai commented Jan 2, 2020 • edited Loading

codecov bot commented Jan 2, 2020 • edited Loading

Codecov Report

jcnelson Jan 5, 2020

Choose a reason for hiding this comment

jcnelson Jan 5, 2020 • edited Loading

Choose a reason for hiding this comment

jcnelson Jan 5, 2020

Choose a reason for hiding this comment

kantai Jan 7, 2020

Choose a reason for hiding this comment

jcnelson left a comment

Choose a reason for hiding this comment

lgalabru left a comment

Choose a reason for hiding this comment

kantai commented Jan 2, 2020 •

edited

Loading

codecov bot commented Jan 2, 2020 •

edited

Loading

jcnelson Jan 5, 2020 •

edited

Loading